Skip to main content

ReitCircles API Reference

ReitCircles provides a comprehensive set of APIs to interact with various aspects of the portal. These APIs follow the OpenAPI Specification (OAS) 3.0 and can be explored through the provided Swagger UI links.

  • API Version: 1.00

Note: These APIs are currently for development purposes and not for production as they are currently being improved upon. However, you can try them out locally on localhost:3000

Answers API​

The Answers API provides endpoints for managing and retrieving answers to questions.

Swagger UI: Answers

HTTP Methods: GET, POST, PUT, DELETE

Assets API​

The Assets API allows you to interact with assets on the platform.

Swagger UI: Assets

HTTP Methods: GET, POST, PUT, DELETE

Authorization API​

The Authorization API handles authorization-related operations.

Swagger UI: Authorization

HTTP Methods: GET, POST, PUT, DELETE

Block API​

The Block API provides endpoints for interacting with the Arweave blockchain.

Swagger UI: Blockchain

HTTP Methods: GET, POST, PUT, DELETE

Documents API​

The Documents API allows you to manage and retrieve document-related information.

Swagger UI: Documents

HTTP Methods: GET, POST, PUT, DELETE

Messaging API​

The Messaging API provides endpoints for sending and receiving messages.

Swagger UI: Messaging

HTTP Methods: GET, POST, PUT, DELETE

Minting API​

The Minting API handles minting-related operations.

Swagger UI: Minting

HTTP Methods: GET, POST, PUT, DELETE

Offers API​

The Offers API provides endpoints for managing and retrieving offers.

Swagger UI: Offers

HTTP Methods: GET, POST, PUT, DELETE

Projects API​

The Projects API allows you to create, retrieve, update, and delete project information, as well as retrieve associated assets for a project.

Swagger UI: Projects

HTTP Methods: GET, POST, PUT, DELETE

Questions API​

The Questions API provides endpoints for managing and retrieving questions.

Swagger UI: Questions

HTTP Methods: GET, POST, PUT, DELETE

Steps API​

The Steps API handles step-related operations.

Swagger UI: Steps

HTTP Methods: GET, POST, PUT, DELETE

Subscriptions API​

The Subscriptions API allows you to manage and retrieve subscriptions on the portal.

Swagger UI: Subscriptions

HTTP Methods: GET, POST, PUT, DELETE

ReitCircles Minting DAO API​

The Minting DAO API handles minting for the ReitCircles decentralized autonomous organization (DAO)

Swagger UI: Temporary Minting

HTTP Methods: GET, POST, PUT, DELETE

Tokens API​

Description: The Tokens API provides endpoints for managing REIT tokens.

Swagger UI: Tokens

HTTP Methods: GET, POST, PUT, DELETE

Users API​

The Users API provides endpoints for managing user accounts, KYC (Know Your Customer) verification, API key management, and user-related information.

Swagger UI: Users

HTTP Methods: GET, POST, PUT, DELETE

For detailed information on each API's endpoints and their respective HTTP methods, refer to the corresponding Swagger UI documentation.